Skip to content
API Documents/
/
/
Update folder

Update folder

Request

Update a folder by ID.

Path
idinteger, (int64)required

Folder to update

Bodyapplication/vnd.treasuredata.v1+json
idstring[1-9][0-9]*
typestring
Value:"folder-segment"
attributesobject
relationshipsobject
curl -i -X PATCH \
  'https://api-cdp.treasuredata.com/entities/folders/{id}' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "id": "string",
    "type": "folder-segment",
    "attributes": {
      "name": "string",
      "description": "string"
    },
    "relationships": {
      "parentFolder": {
        "data": {
          "id": "string",
          "type": "folder-segment"
        }
      }
    }
  }'

Responses

Folder to update

Bodyapplication/vnd.treasuredata.v1+json
dataobject(FolderJsonApiResource)required
includedArray of objects(UserJsonApiResource)required
Response
{
  "data": {
    "id": "string",
    "type": "folder-segment",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ]
}